Sintaxe de Formatação

O WikiAves suporta algumas simples linguagens de marcação, as quais procuram fazer os arquivos de dados serem o mais legíveis possível. Esta página contém todas os comandos possíveis que você pode usar para editar as páginas. Dê uma olhada no código-fonte dessa página clicando no botão Editar esta página no topo ou no rodapé da página. Se você quiser treinar um pouco, use a página playground. As marcações mais simples também são acessíveis através da barra de botões.

Formatação básica de texto

O WikiAves suporta textos em negrito, itálico, sublinhado e monoespaçado. Obviamente você poderá combinar todas elas.

O WikiAves suporta textos em **negrito**, //itálico//,
__sublinhado__ e ''monoespaçado''.
Obviamente você poderá **__//''combinar''//__** todas elas.

Você também pode usar subscrito e sobrescrito.

Você também pode usar <sub>subscrito</sub> e <sup>sobrescrito</sup>.

Você poderá marcar algo como tachado.

Você poderá marcar algo como <del>tachado</del>.

Paragrafos são criados a partir de linhas em branco. Se você quiser forçar a quebra de linha sem um novo parágrafo, você poderá usar duas contra-barras seguidas de um espaço em branco ou o fim da linha.

Este é um texto com algumas quebras-de-linha
Note que as duas contra-barras são reconhecidas apenas no fim da linha
ou seguidas por
um espaço \\isto que acontece sem o espaço.

Este é um texto com algumas quebras-de-linha\\ Note que as
duas contra-barras são reconhecidas apenas no fim da linha\\
ou seguidas por\\ um espaço \\isto que acontece sem o espaço.

Você deve forçar as quebras de linha apenas quando necessário.

O WikiAves suporta múltiplas formas de criar links(ligações entre páginas).

Externos

Links externos são reconhecidos automaticamente: http://www.google.com ou simplismente www.google.com - Você também pode nomear os links: Este link aponta para o Google. Endereços de e-mail como este: andi@splitbrain.org são reconhecidos automaticamente também.

Links externos são reconhecidos automaticamente: http://www.google.com
ou simplesmente www.google.com - Você também pode nomear os links:
[[http://www.google.com|Este link aponta para o Google]]. 
Endereços de e-mail como este: <andi@splitbrain.org> 
também são reconhecidos automaticamente.

Internos

Links internos são criados usando colchetes. Você pode apenas fornecer o wiki:nome_da_pagina ou usar uma descrição adicional Título da Página. Os nomes das páginas wiki são convertidos para minúsculo automaticamente e caracteres especiais não são permitidos.

Links internos são criados usando colchetes. Você pode apenas fornecer
o [[doku>wiki:nome_da_pagina]] ou usar uma descrição adicional
[[doku>wiki:nome_da_pagina|Título da Página]]. Os nomes das páginas 
wiki são convertidos para minúsculo automaticamente e 
caracteres especiais não são permitidos. 

Você pode usar namespaces incluindo dois-pontos no nome da página.

Você pode usar [[wiki:namespaces]] incluindo dois-pontos no nome da página.

Namespaces são diretórios de páginas usados para organizar e evitar que páginas com o mesmo nome entrem em conflito. Clique aqui para saber mais sobre wiki:namespaces(Em inglês).

É possível apontar um link para uma seção específica. Basta adicionar o nome da seção após um caractere de cerquilha(#) assim como no HTML. Este link aponta para esta seção.

Este link aponta para [[syntax#internos|esta seção]].

Notas:

Interwiki

O WikiAves suporta links Interwiki, que são links rápidos com outros wikis. Este é um exemplo de link para a página sobre Wikis da Wikipedia: Wiki.

O WikiAves suporta links [[doku>wiki:interwiki|Interwiki]], que são links 
rápidos com outros wikis. Este é um exemplo de link para a página sobre 
Wikis da Wikipedia: [[wp>Wiki]].

Notas de Rodapé

Você pode adicionar notas de rodapé 1) usando parênteses duplos.

Você pode adicionar notas de rodapé ((Isto é uma nota de rodapé)) usando
parênteses duplos.

Seções

Você pode usar até cinco diferentes níveis de títulos para estruturar seu conteúdo. Se você tiver mais de três níveis, uma Tabela de Conteúdo será gerada automaticamente. A Tabela de Conteúdo aparecerá no lado direito no topo da página e poderá ser desabilitada incluindo o comando ~~NOTOC~~ no documento.

Título Nível 3

Título Nível 4

Título Nível 5
==== Título Nível 3 ====
=== Título Nível 4 ===
== Título Nível 5 ==

Usando quatro ou mais traços, você poderá incluir uma linha horizontal:


Images and other files

You can include external and internal wiki:images with curly brackets. Optionally you can specify the size of them.

Real size:

Resize to given width:

Resize to given width and height:

Resized external image:

Real size:                        {{wiki:dokuwiki-128.png}}
Resize to given width:            {{wiki:dokuwiki-128.png?50}}
Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}}
Resized external image:           {{http://de3.php.net/images/php.gif?200x50}}

By using left or right whitespaces you can choose the alignment.

{{ wiki:dokuwiki-128.png}}
{{wiki:dokuwiki-128.png }}
{{ wiki:dokuwiki-128.png }}

Of course, you can add a title (displayed as a tooltip by most browsers), too.

This is the caption

{{ wiki:dokuwiki-128.png |This is the caption}}

If you specify a filename (external or internal) that is not an image (gif, jpeg, png), then it will be displayed as a link instead.

For linking an image to another page see Image Links above.

Lists

Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a * for unordered lists or a - for ordered ones.

  1. The same list but ordered
  2. Another item
    1. Just use indention for deeper levels
  3. That's it
  * This is a list
  * The second item
    * You may have different levels
  * Another item

  - The same list but ordered
  - Another item
    - Just use indention for deeper levels
  - That's it

Smileys

DokuWiki converts commonly used emoticons to their graphical equivalents. More smileys can be placed in the smiley directory and configured in the conf/smileys.conf file. Here is an overview of Smileys included in DokuWiki.

Typography

DokuWiki can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® “He thought 'It's a man's world'…”

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"He thought 'It's a man's world'..."

Please note: These conversions can be turned off through a config option and a pattern file.

Quoting

Some times you want to mark some text to show it's a reply or comment. You can use the following syntax:

I think we should do it

> No we shouldn't

>> Well, I say we should

> Really?

>> Yes!

>>> Then lets do it!

I think we should do it

No we shouldn't
Well, I say we should
Really?
Yes!
Then lets do it!

Tables

DokuWiki supports a simple syntax to create tables.

Heading 1 Heading 2 Heading 3
Row 1 Col 1 Row 1 Col 2 Row 1 Col 3
Row 2 Col 1 some colspan (note the double pipe)
Row 3 Col 1 Row 2 Col 2 Row 2 Col 3

Table rows have to start and end with a | for normal rows or a ^ for headers.

^ Heading 1      ^ Heading 2       ^ Heading 3          ^
| Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        |
| Row 2 Col 1    | some colspan (note the double pipe) ||
| Row 3 Col 1    | Row 2 Col 2     | Row 2 Col 3        |

To connect cells horizontally, just make the next cell completely empty as shown above. Be sure to have always the same amount of cell separators!

Vertical tableheaders are possible, too.

Heading 1 Heading 2
Heading 3 Row 1 Col 2 Row 1 Col 3
Heading 4 no colspan this time
Heading 5 Row 2 Col 2 Row 2 Col 3

As you can see, it's the cell separator before a cell which decides about the formatting:

|              ^ Heading 1            ^ Heading 2          ^
^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        |
^ Heading 4    | no colspan this time |                    |
^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |

Note: Vertical spans (rowspan) are not possible.

You can align the table contents, too. Just add at least two whitespaces at the opposite end of your text: Add two spaces on the left to align right, two spaces on the right to align left and two spaces at least at both ends for centered text.

Table with alignment
right center left
left right center
xxxxxxxxxxxx xxxxxxxxxxxx xxxxxxxxxxxx

This is how it looks in the source:

^           Table with alignment           ^^^
|         right|    center    |left          |
|left          |         right|    center    |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

Non-parsed Blocks

You can include non-parsed blocks into your documents by either indenting them by at least two spaces (like used for the previous examples) or by using the tags code or file.

This is preformatted code all spaces are preserved: like              <-this
This is pretty much the same, but you could use it to show that you quoted a file.  

To let the parser ignore an area completely (ie. do no formatting on it), enclose the area either with nowiki tags or even simpler, with double percent signs %%.

This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it.

See the source of this page to see how to use these blocks.

Syntax Highlighting

DokuWiki can highlight sourcecode, which makes it easier to read. It uses the GeSHi Generic Syntax Highlighter – so any language supported by GeSHi is supported. The syntax is the same like in the code block in the previous section, but this time the name of the used language is inserted inside the tag. Eg. <code java>.

/** 
 * The HelloWorldApp class implements an application that
 * simply displays "Hello World!" to the standard output.
 */
class HelloWorldApp {
    public static void main(String[] args) {
        System.out.println("Hello World!"); //Display the string.
    }
}

The following language strings are currently recognized: abap actionscript-french, actionscript, ada, apache, applescript, asm, asp, autoit, bash, basic4gl, blitzbasic, bnf, caddcl, cadlisp, cfdg, cfm, c_mac, c, cpp, cpp-qt, csharp, css, delphi, diff, div, dos, dot, d, eiffel, fortran, freebasic, genero, gml, groovy, haskell, html, idl, ini, inno, io, java5, java, javascript, latex, lisp, lua, m68k, matlab, mirc, mpasm, mysql, nsis, objc, ocaml-brief, ocaml, oobas, oracle8, pascal, perl, per, php-brief, php, plsql, python, qbasic, rails, reg, robots, ruby, sas, scheme, sdlbasic, smalltalk, smarty, sql, tcl, text, thinbasic, tsql, vbnet, vb, vhdl, visualfoxpro, winbatch, xml, xpp, z80

RSS/ATOM Feed Aggregation

DokuWiki can integrate data from external XML feeds. For parsing the XML feeds, SimplePie is used. All formats understood by SimplePie can be used in DokuWiki as well. You can influence the rendering by multiple additional space separated parameters:

Parameter Description
any number will be used as maximum number items to show, defaults to 8
reverse display the last items in the feed first
author show item authors names
date show item dates
description show the item description. If HTML is disabled all tags will be stripped
n[dhm] refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours).

The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. DokuWiki will generally try to supply a cached version of a page, obviously this is inappropriate when the page contains dynamic external content. The parameter tells DokuWiki to re-render the page if it is more than refresh period since the page was last rendered.

Example:

{{rss>http://slashdot.org/index.rss 5 author date 1h }}

Embedding HTML and PHP

You can embed raw HTML or PHP code into your documents by using the html or php tags like this:

<html>
This is some <span style="color:red;font-size:150%;">inline HTML</span>
</html>
<HTML>
<p style="border:2px dashed red;">And this is some block HTML</p>
</HTML>

This is some <span style="color:red;font-size:150%;">inline HTML</span>

<p style="border:2px dashed red;">And this is some block HTML</p>
<php>
echo 'A logo generated by PHP:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
echo '(generated inline HTML)';
</php>
<PHP>
echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>';
echo '<td><img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" /></td>';
echo '</tr></table>';
</PHP>

echo 'A logo generated by PHP:'; echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />'; echo '(inline HTML)';

echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>';
echo '<td><img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" /></td>';
echo '</tr></table>';

Please Note: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed.

Control Macros

Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble:

Macro Description
~~NOTOC~~ If this macro is found on the page, no table of contents will be created
~~NOCACHE~~ DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the <php> syntax above is used), adding this macro will force DokuWiki to rerender a page on every call

Syntax Plugins

DokuWiki's syntax can be extended by Plugins. How the installed plugins are used is described on their appropriate description pages. The following syntax plugins are available in this particular DokuWiki installation:

1)
Isto é uma nota de rodapé